/*!	 layersetdesc.cpp
**	 Template File
**
**	Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
**	Copyright (c) 2008 Chris Moore
**
**	This package is free software; you can redistribute it and/or
**	modify it under the terms of the GNU General Public License as
**	published by the Free Software Foundation; either version 2 of
**	the License, or (at your option) any later version.
**
**	This package is distributed in the hope that it will be useful,
**	but WITHOUT ANY WARRANTY; without even the implied warranty of
**	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
**	General Public License for more details.
**
*/

#ifdef USING_PCH
#	include "pch.h"
#else
#ifdef HAVE_CONFIG_H
#	include <config.h>
#endif

#include <synfig/general.h>

#include "layersetdesc.h"
#include <synfigapp/canvasinterface.h>

#include <synfigapp/localization.h>

#endif

using namespace std;
using namespace etl;
using namespace synfig;
using namespace synfigapp;
using namespace Action;

ACTION_INIT_NO_GET_LOCAL_NAME(Action::LayerSetDesc);
ACTION_SET_NAME(Action::LayerSetDesc, "LayerSetDesc");
ACTION_SET_LOCAL_NAME(Action::LayerSetDesc, N_("Set Layer Description"));
ACTION_SET_TASK(Action::LayerSetDesc, "set_desc");
ACTION_SET_CATEGORY(Action::LayerSetDesc, Action::CATEGORY_LAYER);
ACTION_SET_PRIORITY(Action::LayerSetDesc, 0);
ACTION_SET_VERSION(Action::LayerSetDesc, "0.0");
ACTION_SET_CVS_ID(Action::LayerSetDesc, "$Id$");

// static const int nindex=-1;

Action::LayerSetDesc::LayerSetDesc()
{
}

synfig::String
Action::LayerSetDesc::get_local_name()const
{
    return strprintf("%s: '%s' -> '%s'",
                     _("Set Layer Description"),
                     /* TRANSLATORS: this is the string used in the history dialog when renaming a layer to/from its default name */
                     old_description.empty() ? _("[default]") : old_description.c_str(),
                     new_description.empty() ? _("[default]") : new_description.c_str());
}

Action::ParamVocab
Action::LayerSetDesc::get_param_vocab()
{
    ParamVocab ret(Action::CanvasSpecific::get_param_vocab());

    ret.push_back(ParamDesc("layer", Param::TYPE_LAYER)
                  .set_local_name(_("Layer"))
                  .set_desc(_("Layer to be described"))
                 );

    ret.push_back(ParamDesc("new_description", Param::TYPE_STRING)
                  .set_local_name(_("New Description"))
                  .set_local_name(_("Enter a new description for this layer"))
                  .set_user_supplied()
                  .set_value_provided()
                 );

    return ret;
}

bool
Action::LayerSetDesc::is_candidate(const ParamList &x)
{
    return candidate_check(get_param_vocab(), x);
}

bool
Action::LayerSetDesc::set_param(const synfig::String& name, const Action::Param &param)
{
    if (name == "layer" && param.get_type() == Param::TYPE_LAYER) {
        layer = param.get_layer();

        return true;
    }

    if (name == "new_description" && param.get_type() == Param::TYPE_STRING) {
        new_description = param.get_string();

        return true;
    }

    return Action::CanvasSpecific::set_param(name, param);
}

bool
Action::LayerSetDesc::get_param(const synfig::String& name, Action::Param &param)
{
    if (name == "new_description") {
        param = layer->get_description();

        return true;
    }

    return Action::CanvasSpecific::get_param(name, param);
}

bool
Action::LayerSetDesc::is_ready()const
{
    if (!layer) {
        return false;
    }

    return Action::CanvasSpecific::is_ready();
}

void
Action::LayerSetDesc::perform()
{
    old_description = layer->get_description();
    layer->set_description(new_description);
    set_dirty(false);

    if (get_canvas_interface()) {
        get_canvas_interface()->signal_layer_new_description()(layer, new_description);
    } else {
        synfig::warning("CanvasInterface not set on action");
    }
}

void
Action::LayerSetDesc::undo()
{
    layer->set_description(old_description);
    set_dirty(false);

    if (get_canvas_interface()) {
        get_canvas_interface()->signal_layer_new_description()(layer, old_description);
    } else {
        synfig::warning("CanvasInterface not set on action");
    }
}